Content Understanding (preview:2025-05-01)

2025/05/19 • 37 new methods

ContentAnalyzers_GetResult (new)
Description :  Get the result of an analysis operation.
Reference :  Link ¶

⚼ Request

GET:  /analyzerResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The version of the API used to analyze the document. ,
Required: False ,
}
string ,
createdAt:
{
Description: The date and time when the result was created. ,
Format: date-time ,
Required: False ,
}
string ,
warnings:
{
Description: Warnings encountered while analyzing the document. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
stringEncoding:
{
Description: The string encoding used for content spans. ,
Enum:
{
codePoint: Unicode code point (UTF-32) encoding, used by languages such as Python, etc. ,
utf16: UTF-16 encoding, used by languages such as C#, JavaScript, Java, etc. ,
utf8: UTF-8 encoding, used by languages such as Go, Rust, Ruby, PHP, etc. ,
}
,
Required: False ,
}
enum ,
contents:
{
Description: The extracted content. ,
Required: True ,
}
[
{
kind:
{
Description: Content kind. ,
Enum:
{
document: Document content, such as pdf, image, txt, etc. ,
audioVisual: Audio visual content, such as mp3, mp4, etc. ,
}
,
Required: True ,
}
enum ,
mimeType:
{
Description: Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc. ,
Required: False ,
}
string ,
category:
{
Description: Classified content category. ,
Required: False ,
}
string ,
path:
{
Description: The path of the content in the input. ,
Format: uri ,
Required: False ,
}
string ,
markdown:
{
Description: Markdown representation of the content. ,
Required: False ,
}
string ,
fields:
{
Description: Extracted fields from the content. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_GetResultFile (new)
Description :  Get a file associated with the result of an analysis operation.
Reference :  Link ¶

⚼ Request

GET:  /analyzerResults/{operationId}/files/{path}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier. ,
Required: True ,
}
string ,
path:
{
Description: File path. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_List (new)
Description :  List analyzers.
Reference :  Link ¶

⚼ Request

GET:  /analyzers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of ContentAnalyzer items ,
}
{
value:
{
Description: The ContentAnalyzer items on this page ,
Required: True ,
}
[
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
personDirectoryId:
{
Description: Specify the person directory used for identifying detected faces. ,
Required: False ,
}
string ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. , } ,
Required: False ,
} enum ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
disableContentFiltering:
{
Description: Disable content filtering that detects and prevents the output of harmful content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return grounding source and confidence for extracted fields. ,
Required: False ,
}
boolean ,
segmentationMode:
{
Description: Segmentation mode used to split audio/visual content. ,
Enum:
{
noSegmentation: No segmentation. ,
auto: Automatic segmentation. ,
custom: Segment according to custom segmentation definition. ,
}
,
Required: False ,
}
enum ,
segmentationDefinition:
{
Description: Segmentation definition for use with custom segmentation mode. ,
Required: False ,
}
string ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The analysis mode: standard, pro. Default is standard. ,
Enum:
{
standard: Standard analysis mode. ,
pro: Pro analysis mode. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
reference: A reference knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
} , ] ,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
} , }

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_Get (new)
Description :  Get analyzer properties.
Reference :  Link ¶

⚼ Request

GET:  /analyzers/{analyzerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Analyzer that extracts content and fields from multimodal documents. ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
personDirectoryId:
{
Description: Specify the person directory used for identifying detected faces. ,
Required: False ,
}
string ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. , } ,
Required: False ,
} enum ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
disableContentFiltering:
{
Description: Disable content filtering that detects and prevents the output of harmful content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return grounding source and confidence for extracted fields. ,
Required: False ,
}
boolean ,
segmentationMode:
{
Description: Segmentation mode used to split audio/visual content. ,
Enum:
{
noSegmentation: No segmentation. ,
auto: Automatic segmentation. ,
custom: Segment according to custom segmentation definition. ,
}
,
Required: False ,
}
enum ,
segmentationDefinition:
{
Description: Segmentation definition for use with custom segmentation mode. ,
Required: False ,
}
string ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The analysis mode: standard, pro. Default is standard. ,
Enum:
{
standard: Standard analysis mode. ,
pro: Pro analysis mode. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
reference: A reference knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
} , }

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_CreateOrReplace (new)
Description :  Create a new analyzer asynchronously.
Reference :  Link ¶

⚼ Request

PUT:  /analyzers/{analyzerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
personDirectoryId:
{
Description: Specify the person directory used for identifying detected faces. ,
Required: False ,
}
string ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. , } ,
Required: False ,
} enum ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
disableContentFiltering:
{
Description: Disable content filtering that detects and prevents the output of harmful content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return grounding source and confidence for extracted fields. ,
Required: False ,
}
boolean ,
segmentationMode:
{
Description: Segmentation mode used to split audio/visual content. ,
Enum:
{
noSegmentation: No segmentation. ,
auto: Automatic segmentation. ,
custom: Segment according to custom segmentation definition. ,
}
,
Required: False ,
}
enum ,
segmentationDefinition:
{
Description: Segmentation definition for use with custom segmentation mode. ,
Required: False ,
}
string ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The analysis mode: standard, pro. Default is standard. ,
Enum:
{
standard: Standard analysis mode. ,
pro: Pro analysis mode. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
reference: A reference knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
} , }

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Analyzer that extracts content and fields from multimodal documents. ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
personDirectoryId:
{
Description: Specify the person directory used for identifying detected faces. ,
Required: False ,
}
string ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. , } ,
Required: False ,
} enum ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
disableContentFiltering:
{
Description: Disable content filtering that detects and prevents the output of harmful content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return grounding source and confidence for extracted fields. ,
Required: False ,
}
boolean ,
segmentationMode:
{
Description: Segmentation mode used to split audio/visual content. ,
Enum:
{
noSegmentation: No segmentation. ,
auto: Automatic segmentation. ,
custom: Segment according to custom segmentation definition. ,
}
,
Required: False ,
}
enum ,
segmentationDefinition:
{
Description: Segmentation definition for use with custom segmentation mode. ,
Required: False ,
}
string ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The analysis mode: standard, pro. Default is standard. ,
Enum:
{
standard: Standard analysis mode. ,
pro: Pro analysis mode. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
reference: A reference knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
} , }

⚐ Response (201)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Analyzer that extracts content and fields from multimodal documents. ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
personDirectoryId:
{
Description: Specify the person directory used for identifying detected faces. ,
Required: False ,
}
string ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. , } ,
Required: False ,
} enum ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
disableContentFiltering:
{
Description: Disable content filtering that detects and prevents the output of harmful content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return grounding source and confidence for extracted fields. ,
Required: False ,
}
boolean ,
segmentationMode:
{
Description: Segmentation mode used to split audio/visual content. ,
Enum:
{
noSegmentation: No segmentation. ,
auto: Automatic segmentation. ,
custom: Segment according to custom segmentation definition. ,
}
,
Required: False ,
}
enum ,
segmentationDefinition:
{
Description: Segmentation definition for use with custom segmentation mode. ,
Required: False ,
}
string ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The analysis mode: standard, pro. Default is standard. ,
Enum:
{
standard: Standard analysis mode. ,
pro: Pro analysis mode. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
reference: A reference knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
} , }

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_Update (new)
Description :  Update analyzer properties.
Reference :  Link ¶

⚼ Request

PATCH:  /analyzers/{analyzerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
reference: A reference knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Analyzer that extracts content and fields from multimodal documents. ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
personDirectoryId:
{
Description: Specify the person directory used for identifying detected faces. ,
Required: False ,
}
string ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. , } ,
Required: False ,
} enum ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
disableContentFiltering:
{
Description: Disable content filtering that detects and prevents the output of harmful content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return grounding source and confidence for extracted fields. ,
Required: False ,
}
boolean ,
segmentationMode:
{
Description: Segmentation mode used to split audio/visual content. ,
Enum:
{
noSegmentation: No segmentation. ,
auto: Automatic segmentation. ,
custom: Segment according to custom segmentation definition. ,
}
,
Required: False ,
}
enum ,
segmentationDefinition:
{
Description: Segmentation definition for use with custom segmentation mode. ,
Required: False ,
}
string ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The analysis mode: standard, pro. Default is standard. ,
Enum:
{
standard: Standard analysis mode. ,
pro: Pro analysis mode. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
reference: A reference knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
} , }

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_Delete (new)
Description :  Delete analyzer.
Reference :  Link ¶

⚼ Request

DELETE:  /analyzers/{analyzerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_Analyze (new)
Description :  Extract content and fields from input.
Reference :  Link ¶

⚼ Request

POST:  /analyzers/{analyzerId}:analyze
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
stringEncoding:
{
Description: The encoding format for content spans in the response. ,
Required: False ,
}
string ,
processingLocation:
{
Description: The location where the data may be processed. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
url:
{
Description: The URL of the primary input to analyze. Only one of url or data should be specified. ,
Format: uri ,
Required: False ,
}
string ,
data:
{
Description: Base64-encoded binary content of the primary input to analyze. Only one of url or data should be specified. ,
Format: byte ,
Required: False ,
}
string ,
inputs:
{
Description: Additional inputs to analyze. Only supported in analyzers with mode=pro. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the input to analyze. Only one of url or data should be specified. ,
Format: uri ,
Required: True ,
}
string ,
data:
{
Description: Base64-encoded binary content of the input to analyze. Only one of url or data should be specified. ,
Format: byte ,
Required: False ,
}
string ,
name:
{
Description: Name of the input. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Provides status details for long running operations. ,
}
{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The version of the API used to analyze the document. ,
Required: False ,
}
string ,
createdAt:
{
Description: The date and time when the result was created. ,
Format: date-time ,
Required: False ,
}
string ,
warnings:
{
Description: Warnings encountered while analyzing the document. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
stringEncoding:
{
Description: The string encoding used for content spans. ,
Enum:
{
codePoint: Unicode code point (UTF-32) encoding, used by languages such as Python, etc. ,
utf16: UTF-16 encoding, used by languages such as C#, JavaScript, Java, etc. ,
utf8: UTF-8 encoding, used by languages such as Go, Rust, Ruby, PHP, etc. ,
}
,
Required: False ,
}
enum ,
contents:
{
Description: The extracted content. ,
Required: True ,
}
[
{
kind:
{
Description: Content kind. ,
Enum:
{
document: Document content, such as pdf, image, txt, etc. ,
audioVisual: Audio visual content, such as mp3, mp4, etc. ,
}
,
Required: True ,
}
enum ,
mimeType:
{
Description: Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc. ,
Required: False ,
}
string ,
category:
{
Description: Classified content category. ,
Required: False ,
}
string ,
path:
{
Description: The path of the content in the input. ,
Format: uri ,
Required: False ,
}
string ,
markdown:
{
Description: Markdown representation of the content. ,
Required: False ,
}
string ,
fields:
{
Description: Extracted fields from the content. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_GetOperationStatus (new)
Description :  Get the status of an analyzer creation operation.
Reference :  Link ¶

⚼ Request

GET:  /analyzers/{analyzerId}/operations/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
operationId:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
personDirectoryId:
{
Description: Specify the person directory used for identifying detected faces. ,
Required: False ,
}
string ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. , } ,
Required: False ,
} enum ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
disableContentFiltering:
{
Description: Disable content filtering that detects and prevents the output of harmful content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return grounding source and confidence for extracted fields. ,
Required: False ,
}
boolean ,
segmentationMode:
{
Description: Segmentation mode used to split audio/visual content. ,
Enum:
{
noSegmentation: No segmentation. ,
auto: Automatic segmentation. ,
custom: Segment according to custom segmentation definition. ,
}
,
Required: False ,
}
enum ,
segmentationDefinition:
{
Description: Segmentation definition for use with custom segmentation mode. ,
Required: False ,
}
string ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The analysis mode: standard, pro. Default is standard. ,
Enum:
{
standard: Standard analysis mode. ,
pro: Pro analysis mode. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
reference: A reference knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
} , }

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentClassifiers_GetResult (new)
Description :  Get the result of a classifier operation.
Reference :  Link ¶

⚼ Request

GET:  /classifierResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The version of the API used to classify the document. ,
Required: False ,
}
string ,
createdAt:
{
Description: The date and time when the result was created. ,
Format: date-time ,
Required: False ,
}
string ,
warnings:
{
Description: Warnings encountered while classifying the document. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
stringEncoding:
{
Description: The string encoding used for content spans. ,
Enum:
{
codePoint: Unicode code point (UTF-32) encoding, used by languages such as Python, etc. ,
utf16: UTF-16 encoding, used by languages such as C#, JavaScript, Java, etc. ,
utf8: UTF-8 encoding, used by languages such as Go, Rust, Ruby, PHP, etc. ,
}
,
Required: False ,
}
enum ,
contents:
{
Description: The classified content. ,
Required: True ,
}
[
{
kind:
{
Description: Content kind. ,
Enum:
{
document: Document content, such as pdf, image, txt, etc. ,
audioVisual: Audio visual content, such as mp3, mp4, etc. ,
}
,
Required: True ,
}
enum ,
mimeType:
{
Description: Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc. ,
Required: False ,
}
string ,
category:
{
Description: Classified content category. ,
Required: False ,
}
string ,
path:
{
Description: The path of the content in the input. ,
Format: uri ,
Required: False ,
}
string ,
markdown:
{
Description: Markdown representation of the content. ,
Required: False ,
}
string ,
fields:
{
Description: Extracted fields from the content. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentClassifiers_List (new)
Description :  List classifiers.
Reference :  Link ¶

⚼ Request

GET:  /classifiers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of ContentClassifier items ,
}
{
value:
{
Description: The ContentClassifier items on this page ,
Required: True ,
}
[
{
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
description:
{
Description: A description of the classifier. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the classifier. ,
Required: False ,
}
object ,
status:
{
Description: The status of the classifier. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the classifier was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the classifier was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the classifier. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
categories:
{
Description: The categories to classify against. ,
Required: True ,
}
object ,
splitMode:
{
Description: Mode used to split input into content objects. ,
Enum:
{
noSplit: Treat the entire input as a single content object. ,
perPage: Split each page of the input into a separate content object. ,
auto: Split the input into content objects based on the input and category definitions. ,
}
,
Required: False ,
}
enum ,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentClassifiers_Get (new)
Description :  Get classifier properties.
Reference :  Link ¶

⚼ Request

GET:  /classifiers/{classifierId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Classifier that classifies content into categories with optional splitting. ,
}
{
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
description:
{
Description: A description of the classifier. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the classifier. ,
Required: False ,
}
object ,
status:
{
Description: The status of the classifier. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the classifier was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the classifier was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the classifier. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
categories:
{
Description: The categories to classify against. ,
Required: True ,
}
object ,
splitMode:
{
Description: Mode used to split input into content objects. ,
Enum:
{
noSplit: Treat the entire input as a single content object. ,
perPage: Split each page of the input into a separate content object. ,
auto: Split the input into content objects based on the input and category definitions. ,
}
,
Required: False ,
}
enum ,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentClassifiers_CreateOrReplace (new)
Description :  Create a new classifier asynchronously.
Reference :  Link ¶

⚼ Request

PUT:  /classifiers/{classifierId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
description:
{
Description: A description of the classifier. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the classifier. ,
Required: False ,
}
object ,
status:
{
Description: The status of the classifier. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the classifier was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the classifier was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the classifier. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
categories:
{
Description: The categories to classify against. ,
Required: True ,
}
object ,
splitMode:
{
Description: Mode used to split input into content objects. ,
Enum:
{
noSplit: Treat the entire input as a single content object. ,
perPage: Split each page of the input into a separate content object. ,
auto: Split the input into content objects based on the input and category definitions. ,
}
,
Required: False ,
}
enum ,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Classifier that classifies content into categories with optional splitting. ,
}
{
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
description:
{
Description: A description of the classifier. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the classifier. ,
Required: False ,
}
object ,
status:
{
Description: The status of the classifier. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the classifier was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the classifier was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the classifier. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
categories:
{
Description: The categories to classify against. ,
Required: True ,
}
object ,
splitMode:
{
Description: Mode used to split input into content objects. ,
Enum:
{
noSplit: Treat the entire input as a single content object. ,
perPage: Split each page of the input into a separate content object. ,
auto: Split the input into content objects based on the input and category definitions. ,
}
,
Required: False ,
}
enum ,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Classifier that classifies content into categories with optional splitting. ,
}
{
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
description:
{
Description: A description of the classifier. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the classifier. ,
Required: False ,
}
object ,
status:
{
Description: The status of the classifier. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the classifier was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the classifier was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the classifier. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
categories:
{
Description: The categories to classify against. ,
Required: True ,
}
object ,
splitMode:
{
Description: Mode used to split input into content objects. ,
Enum:
{
noSplit: Treat the entire input as a single content object. ,
perPage: Split each page of the input into a separate content object. ,
auto: Split the input into content objects based on the input and category definitions. ,
}
,
Required: False ,
}
enum ,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentClassifiers_Update (new)
Description :  Update classifier properties.
Reference :  Link ¶

⚼ Request

PATCH:  /classifiers/{classifierId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
description:
{
Description: A description of the classifier. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the classifier. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Classifier that classifies content into categories with optional splitting. ,
}
{
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
description:
{
Description: A description of the classifier. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the classifier. ,
Required: False ,
}
object ,
status:
{
Description: The status of the classifier. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the classifier was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the classifier was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the classifier. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
categories:
{
Description: The categories to classify against. ,
Required: True ,
}
object ,
splitMode:
{
Description: Mode used to split input into content objects. ,
Enum:
{
noSplit: Treat the entire input as a single content object. ,
perPage: Split each page of the input into a separate content object. ,
auto: Split the input into content objects based on the input and category definitions. ,
}
,
Required: False ,
}
enum ,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentClassifiers_Delete (new)
Description :  Delete classifier.
Reference :  Link ¶

⚼ Request

DELETE:  /classifiers/{classifierId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentClassifiers_Classify (new)
Description :  Classify content with optional splitting.
Reference :  Link ¶

⚼ Request

POST:  /classifiers/{classifierId}:classify
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
stringEncoding:
{
Description: The encoding format for content spans in the response. ,
Required: False ,
}
string ,
processingLocation:
{
Description: The location where the data may be processed. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
url:
{
Description: The URL of the document to classify. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Provides status details for long running operations. ,
}
{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The version of the API used to classify the document. ,
Required: False ,
}
string ,
createdAt:
{
Description: The date and time when the result was created. ,
Format: date-time ,
Required: False ,
}
string ,
warnings:
{
Description: Warnings encountered while classifying the document. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
stringEncoding:
{
Description: The string encoding used for content spans. ,
Enum:
{
codePoint: Unicode code point (UTF-32) encoding, used by languages such as Python, etc. ,
utf16: UTF-16 encoding, used by languages such as C#, JavaScript, Java, etc. ,
utf8: UTF-8 encoding, used by languages such as Go, Rust, Ruby, PHP, etc. ,
}
,
Required: False ,
}
enum ,
contents:
{
Description: The classified content. ,
Required: True ,
}
[
{
kind:
{
Description: Content kind. ,
Enum:
{
document: Document content, such as pdf, image, txt, etc. ,
audioVisual: Audio visual content, such as mp3, mp4, etc. ,
}
,
Required: True ,
}
enum ,
mimeType:
{
Description: Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc. ,
Required: False ,
}
string ,
category:
{
Description: Classified content category. ,
Required: False ,
}
string ,
path:
{
Description: The path of the content in the input. ,
Format: uri ,
Required: False ,
}
string ,
markdown:
{
Description: Markdown representation of the content. ,
Required: False ,
}
string ,
fields:
{
Description: Extracted fields from the content. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentClassifiers_GetOperationStatus (new)
Description :  Get the status of a classifier creation operation.
Reference :  Link ¶

⚼ Request

GET:  /classifiers/{classifierId}/operations/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
operationId:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
classifierId:
{
Description: The unique identifier of the classifier. ,
Required: True ,
}
string ,
description:
{
Description: A description of the classifier. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the classifier. ,
Required: False ,
}
object ,
status:
{
Description: The status of the classifier. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the classifier was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the classifier was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the classifier. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
categories:
{
Description: The categories to classify against. ,
Required: True ,
}
object ,
splitMode:
{
Description: Mode used to split input into content objects. ,
Enum:
{
noSplit: Treat the entire input as a single content object. ,
perPage: Split each page of the input into a separate content object. ,
auto: Split the input into content objects based on the input and category definitions. ,
}
,
Required: False ,
}
enum ,
processingLocation:
{
Description: The location where the data may be processed. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Faces_Compare (new)
Description :  Compare the similarity between two faces.
Reference :  Link ¶

⚼ Request

POST:  /faces:compare
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
faceSource1:
{
Description: First face to compare. ,
Required: True ,
}
{
url:
{
Description: Image URL. Only one of url or data should be specified. ,
Format: uri ,
Required: False ,
}
string ,
data:
{
Description: Base64-encoded image data. Only one of url or data should be specified. ,
Format: byte ,
Required: False ,
}
string ,
imageReferenceId:
{
Description: User provided identifier for the source image. ,
Required: False ,
}
string ,
targetBoundingBox:
{
Description: Bounding box specifying the region of interest. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
faceSource2:
{
Description: Second face to compare. ,
Required: True ,
}
{
url:
{
Description: Image URL. Only one of url or data should be specified. ,
Format: uri ,
Required: False ,
}
string ,
data:
{
Description: Base64-encoded image data. Only one of url or data should be specified. ,
Format: byte ,
Required: False ,
}
string ,
imageReferenceId:
{
Description: User provided identifier for the source image. ,
Required: False ,
}
string ,
targetBoundingBox:
{
Description: Bounding box specifying the region of interest. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (200)

{
detectedFace1:
{
Description: Details of the first detected face. ,
Required: True ,
}
{
boundingBox:
{
Description: Bounding box of the detected face. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
detectedFace2:
{
Description: Details of the second detected face. ,
Required: True ,
}
{
boundingBox:
{
Description: Bounding box of the detected face. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
confidence:
{
Description: Confidence score of the face comparison. ,
Format: float ,
Required: True ,
}
number ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Faces_Detect (new)
Description :  Detect faces in an image.
Reference :  Link ¶

⚼ Request

POST:  /faces:detect
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
url:
{
Description: Image URL. Only one of url or data should be specified. ,
Required: False ,
}
string ,
data:
{
Description: Base64-encoded image data. Only one of url or data should be specified. ,
Format: byte ,
Required: False ,
}
string ,
maxDetectedFaces:
{
Description: Maximum number of faces to return (up to 100). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
detectedFaces:
{
Description: List of detected faces. ,
Required: True ,
}
[
{
boundingBox:
{
Description: Bounding box of the detected face. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_List (new)
Description :  List person directories.
Reference :  Link ¶

⚼ Request

GET:  /personDirectories
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of PersonDirectory items ,
}
{
value:
{
Description: The PersonDirectory items on this page ,
Required: True ,
}
[
{
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
description:
{
Description: A description of the person directory. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the person directory. ,
Required: False ,
}
object ,
createdAt:
{
Description: The date and time when the person directory was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the person directory was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
personCount:
{
Description: Number of people in the person directory. ,
Format: int32 ,
Required: True ,
}
integer ,
faceCount:
{
Description: Number of faces in the person directory. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_Get (new)
Description :  Get person directory properties.
Reference :  Link ¶

⚼ Request

GET:  /personDirectories/{personDirectoryId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Directory of people and their faces. ,
}
{
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
description:
{
Description: A description of the person directory. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the person directory. ,
Required: False ,
}
object ,
createdAt:
{
Description: The date and time when the person directory was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the person directory was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
personCount:
{
Description: Number of people in the person directory. ,
Format: int32 ,
Required: True ,
}
integer ,
faceCount:
{
Description: Number of faces in the person directory. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_Create (new)
Description :  Create a new person directory.
Reference :  Link ¶

⚼ Request

PUT:  /personDirectories/{personDirectoryId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
description:
{
Description: A description of the person directory. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the person directory. ,
Required: False ,
}
object ,
createdAt:
{
Description: The date and time when the person directory was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the person directory was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
personCount:
{
Description: Number of people in the person directory. ,
Format: int32 ,
Required: True ,
}
integer ,
faceCount:
{
Description: Number of faces in the person directory. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Directory of people and their faces. ,
}
{
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
description:
{
Description: A description of the person directory. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the person directory. ,
Required: False ,
}
object ,
createdAt:
{
Description: The date and time when the person directory was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the person directory was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
personCount:
{
Description: Number of people in the person directory. ,
Format: int32 ,
Required: True ,
}
integer ,
faceCount:
{
Description: Number of faces in the person directory. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_Update (new)
Description :  Update person directory properties.
Reference :  Link ¶

⚼ Request

PATCH:  /personDirectories/{personDirectoryId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
description:
{
Description: A description of the person directory. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the person directory. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Directory of people and their faces. ,
}
{
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
description:
{
Description: A description of the person directory. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the person directory. ,
Required: False ,
}
object ,
createdAt:
{
Description: The date and time when the person directory was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the person directory was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
personCount:
{
Description: Number of people in the person directory. ,
Format: int32 ,
Required: True ,
}
integer ,
faceCount:
{
Description: Number of faces in the person directory. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_Delete (new)
Description :  Delete person directory and all associated persons and faces.
Reference :  Link ¶

⚼ Request

DELETE:  /personDirectories/{personDirectoryId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_ListFaces (new)
Description :  List faces.
Reference :  Link ¶

⚼ Request

GET:  /personDirectories/{personDirectoryId}/faces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of PersonDirectoryFace items ,
}
{
value:
{
Description: The PersonDirectoryFace items on this page ,
Required: True ,
}
[
{
faceId:
{
Description: The unique identifier of the face. ,
Required: True ,
}
string ,
personId:
{
Description: Person associated with the face, if any. ,
Required: False ,
}
string ,
imageReferenceId:
{
Description: User provided identifier for the source image. ,
Required: False ,
}
string ,
boundingBox:
{
Description: Bounding box of the face in the source image. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_AddFace (new)
Description :  Add a new face.
Reference :  Link ¶

⚼ Request

POST:  /personDirectories/{personDirectoryId}/faces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
faceSource:
{
Description: Source of the face. ,
Required: True ,
}
{
url:
{
Description: Image URL. Only one of url or data should be specified. ,
Format: uri ,
Required: False ,
}
string ,
data:
{
Description: Base64-encoded image data. Only one of url or data should be specified. ,
Format: byte ,
Required: False ,
}
string ,
imageReferenceId:
{
Description: User provided identifier for the source image. ,
Required: False ,
}
string ,
targetBoundingBox:
{
Description: Bounding box specifying the region of interest. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
personId:
{
Description: Person identifier with which to associate the face. ,
Required: False ,
}
string ,
qualityThreshold:
{
Description: Face quality threshold below which the face will not be added. Default is medium. ,
Enum:
{
low: Low quality. ,
medium: Medium quality. ,
high: High quality. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of an instance of PersonDirectoryFace ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Face in a person directory. ,
}
{
faceId:
{
Description: The unique identifier of the face. ,
Required: True ,
}
string ,
personId:
{
Description: Person associated with the face, if any. ,
Required: False ,
}
string ,
imageReferenceId:
{
Description: User provided identifier for the source image. ,
Required: False ,
}
string ,
boundingBox:
{
Description: Bounding box of the face in the source image. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_GetFace (new)
Description :  Get face properties.
Reference :  Link ¶

⚼ Request

GET:  /personDirectories/{personDirectoryId}/faces/{faceId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
faceId:
{
Description: The unique identifier of the face. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Face in a person directory. ,
}
{
faceId:
{
Description: The unique identifier of the face. ,
Required: True ,
}
string ,
personId:
{
Description: Person associated with the face, if any. ,
Required: False ,
}
string ,
imageReferenceId:
{
Description: User provided identifier for the source image. ,
Required: False ,
}
string ,
boundingBox:
{
Description: Bounding box of the face in the source image. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_UpdateFace (new)
Description :  Update face properties, such as modifying the association with a person.
Reference :  Link ¶

⚼ Request

PATCH:  /personDirectories/{personDirectoryId}/faces/{faceId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
faceId:
{
Description: The unique identifier of the face. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
personId:
{
Description: Person associated with the face, if any. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Face in a person directory. ,
}
{
faceId:
{
Description: The unique identifier of the face. ,
Required: True ,
}
string ,
personId:
{
Description: Person associated with the face, if any. ,
Required: False ,
}
string ,
imageReferenceId:
{
Description: User provided identifier for the source image. ,
Required: False ,
}
string ,
boundingBox:
{
Description: Bounding box of the face in the source image. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_DeleteFace (new)
Description :  Delete face. Any linked person will be disassociated, but not deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /personDirectories/{personDirectoryId}/faces/{faceId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
faceId:
{
Description: The unique identifier of the face. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_FindSimilarFaces (new)
Description :  Find similar faces.
Reference :  Link ¶

⚼ Request

POST:  /personDirectories/{personDirectoryId}/faces:find
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
faceSource:
{
Description: Source of the face. ,
Required: False ,
}
{
url:
{
Description: Image URL. Only one of url or data should be specified. ,
Format: uri ,
Required: False ,
}
string ,
data:
{
Description: Base64-encoded image data. Only one of url or data should be specified. ,
Format: byte ,
Required: False ,
}
string ,
imageReferenceId:
{
Description: User provided identifier for the source image. ,
Required: False ,
}
string ,
targetBoundingBox:
{
Description: Bounding box specifying the region of interest. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
maxSimilarFaces:
{
Description: Maximum number of similar faces to return (up to 1000). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Find similar faces response. ,
}
{
detectedFace:
{
Description: Details of the detected face. ,
Required: True ,
}
{
boundingBox:
{
Description: Bounding box of the detected face. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
similarFaces:
{
Description: List of similar faces. ,
Required: True ,
}
[
{
faceId:
{
Description: The unique identifier of the face. ,
Required: True ,
}
string ,
personId:
{
Description: Person associated with the face, if any. ,
Required: False ,
}
string ,
imageReferenceId:
{
Description: User provided identifier for the source image. ,
Required: False ,
}
string ,
boundingBox:
{
Description: Bounding box of the face in the source image. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
confidence:
{
Description: Confidence that this face matches the input face. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_ListPersons (new)
Description :  List persons.
Reference :  Link ¶

⚼ Request

GET:  /personDirectories/{personDirectoryId}/persons
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of PersonDirectoryPerson items ,
}
{
value:
{
Description: The PersonDirectoryPerson items on this page ,
Required: True ,
}
[
{
personId:
{
Description: The unique identifier of the person. ,
Required: True ,
}
string ,
tags:
{
Description: Tags associated with the person. ,
Required: False ,
}
object ,
faceIds:
{
Description: List of faces associated with the person. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_AddPerson (new)
Description :  Add a new person and optionally associate with existing faces.
Reference :  Link ¶

⚼ Request

POST:  /personDirectories/{personDirectoryId}/persons
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
tags:
{
Description: Tags associated with the person. ,
Required: False ,
}
object ,
faceIds:
{
Description: List of faces associated with the person. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of an instance of PersonDirectoryPerson ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Person in a person directory. ,
}
{
personId:
{
Description: The unique identifier of the person. ,
Required: True ,
}
string ,
tags:
{
Description: Tags associated with the person. ,
Required: False ,
}
object ,
faceIds:
{
Description: List of faces associated with the person. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_GetPerson (new)
Description :  Get person properties.
Reference :  Link ¶

⚼ Request

GET:  /personDirectories/{personDirectoryId}/persons/{personId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
personId:
{
Description: The unique identifier of the person. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Person in a person directory. ,
}
{
personId:
{
Description: The unique identifier of the person. ,
Required: True ,
}
string ,
tags:
{
Description: Tags associated with the person. ,
Required: False ,
}
object ,
faceIds:
{
Description: List of faces associated with the person. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_UpdatePerson (new)
Description :  Update person properties.
Reference :  Link ¶

⚼ Request

PATCH:  /personDirectories/{personDirectoryId}/persons/{personId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
personId:
{
Description: The unique identifier of the person. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
tags:
{
Description: Tags associated with the person. ,
Required: False ,
}
object ,
faceIds:
{
Description: List of faces associated with the person. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Person in a person directory. ,
}
{
personId:
{
Description: The unique identifier of the person. ,
Required: True ,
}
string ,
tags:
{
Description: Tags associated with the person. ,
Required: False ,
}
object ,
faceIds:
{
Description: List of faces associated with the person. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_DeletePerson (new)
Description :  Delete person. Any linked faces will be disassociated, but not deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /personDirectories/{personDirectoryId}/persons/{personId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
personId:
{
Description: The unique identifier of the person. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_VerifyPerson (new)
Description :  Verify if a face matches the person.
Reference :  Link ¶

⚼ Request

POST:  /personDirectories/{personDirectoryId}/persons/{personId}:verify
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
personId:
{
Description: The unique identifier of the person. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
faceSource:
{
Description: Source of the face. ,
Required: True ,
}
{
url:
{
Description: Image URL. Only one of url or data should be specified. ,
Format: uri ,
Required: False ,
}
string ,
data:
{
Description: Base64-encoded image data. Only one of url or data should be specified. ,
Format: byte ,
Required: False ,
}
string ,
imageReferenceId:
{
Description: User provided identifier for the source image. ,
Required: False ,
}
string ,
targetBoundingBox:
{
Description: Bounding box specifying the region of interest. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Verify person response. ,
}
{
detectedFace:
{
Description: Details of the detected face. ,
Required: True ,
}
{
boundingBox:
{
Description: Bounding box of the detected face. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
confidence:
{
Description: Confidence score of the person verification. ,
Format: float ,
Required: True ,
}
number ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
PersonDirectories_IdentifyPerson (new)
Description :  Identify the person from a face.
Reference :  Link ¶

⚼ Request

POST:  /personDirectories/{personDirectoryId}/persons:identify
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
personDirectoryId:
{
Description: The unique identifier of the person directory. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
faceSource:
{
Description: Source of the face. ,
Required: True ,
}
{
url:
{
Description: Image URL. Only one of url or data should be specified. ,
Format: uri ,
Required: False ,
}
string ,
data:
{
Description: Base64-encoded image data. Only one of url or data should be specified. ,
Format: byte ,
Required: False ,
}
string ,
imageReferenceId:
{
Description: User provided identifier for the source image. ,
Required: False ,
}
string ,
targetBoundingBox:
{
Description: Bounding box specifying the region of interest. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
maxPersonCandidates:
{
Description: Maximum number of person candidates to return (up to 10). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Identify person response. ,
}
{
detectedFace:
{
Description: Details of the detected face. ,
Required: True ,
}
{
boundingBox:
{
Description: Bounding box of the detected face. ,
Required: False ,
}
{
left:
{
Description: Left coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
top:
{
Description: Top coordinate of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
width:
{
Description: Width of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
height:
{
Description: Height of the bounding box. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
personCandidates:
{
Description: List of person candidates matching the input face. ,
Required: True ,
}
[
{
personId:
{
Description: The unique identifier of the person. ,
Required: True ,
}
string ,
tags:
{
Description: Tags associated with the person. ,
Required: False ,
}
object ,
confidence:
{
Description: Confidence score of the person matching the input face. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}